Wiki Markup

Wiki Markuphttp://bill.welliver.org//space/pike/FinScribe/Documentation/Wiki Markup<h3 class="heading-1">Markup<p class="paragraph"/></h3> The Wiki markup engine used by FinScribe turns text that contains simple markup into fully formatted HTML. The markup consists of the symbols added to the text you type that tells the FinScribe wiki engine to format the relevant text in a particular way. These markup commands make it simple to generate richly formatted pages without having to learn complicated codes or language.<p class="paragraph"/> <table> <tr> <th> Markup</th><th>Result</th><th>Description </th> </tr> <tr> <td> 1 Title</td><td> <h3 class="heading-1">Title</td><td> a style 1 heading (major heading) </h3> </td> </tr> <tr> <td> 1.1 Title</td><td> <h3 class="heading-1.1">Title</td><td> a style 1.1 heading (minor heading) </h3> </td> </tr> <tr> <td> - text </td><td> <ul class="minus"> <li>text </td><td> a list item (with -), several lines create a single list</li> </ul></td> </tr> <tr> <td> * text </td><td> <ul class="star"> <li>text </td><td> a list item (with *)</li> </ul></td> </tr> <tr> <td> 1. text </td><td> <ol> <li>text </td><td> an enumerated list</li> </ol></td> </tr> <tr> <td> a. text </td><td> <ol class="alpha"> <li>text </td><td> alphabetical enumerated list</li> </ol></td> </tr> <tr> <td> A. text </td><td> <ol class="ALPHA"> <li>text </td><td> uppercase alphabetical enumerated list</li> </ol></td> </tr> <tr> <td> i. text </td><td> <ol class="roman"> <li>text </td><td> roman enumerated list</li> </ol></td> </tr> <tr> <td> I. text </td><td> <ol class="ROMAN"> <li>text </td><td> uppercase roman enumerated list</li> </ol></td> </tr> <tr> <td> g. text </td><td> <ol class="greek"> <li>text </td><td> greek enumerated list</li> </ol></td> </tr> <tr> <td> h. text </td><td> <ol class="hiragana"> <li>text </td><td> hiragana (japanese) enumerated list</li> </ol></td> </tr> <tr> <td> k. text </td><td> <ol class="katakana"> <li>text </td><td> katakana (japanese) enumerated list</li> </ol></td> </tr> <tr> <td> __bold__ </td><td><b class="bold">bold</b> </td><td> simple bold text </td> </tr> <tr> <td> ~~italics~~ </td><td><i class="ital">italics</i> </td><td> simple italic text </td> </tr> <tr> <td> {{monospace}} </td><td><tt class="monospace">monospace</tt> </td><td> monospace text </td> </tr> <tr> <td> ??citation?? </td><td><cite class="citation">citation</cite> </td><td> citation </td> </tr><p class="paragraph"/> <tr> <td> --strike-- </td><td> <strike class="strike">strike</strike> </td><td> strike through text </td> </tr> <tr> <td> +underscore+ </td><td><ins class="inserted">underscore</ins> </td><td> underline (editing/insertion mark) text </td> </tr> <tr> <td> ^superscript^ </td><td><sup class="superscript">superscript</sup> </td><td> superscript </td> </tr> <tr> <td> ~subscript~ </td><td><sub class="subscript">subscript</sub> </td><td> subscript </td> </tr> <tr> <td> (empty line) </td><td></td><td> produces a new paragraph </td> </tr> <tr> <td> \\ </td><td></td><td> creates a line break, please use sparingly! </td> </tr> <tr> <td> [start] </td><td><a href="/space/start">start</a></td><td> internal link to another document </td> </tr> <tr> <td> http://apple.com/ </td><td> <span class="nobr"><img height="9" width="8" src="/static/images/Icon-Extlink.png" alt="[external]"/><a href="http://apple.com">http://apple.com</a></span> </td><td> creates a link to an external resource, special characters that come after the URL and are not part of it must be separated with a space. </td> </tr> <tr> <td> \X </td><td> { </td><td> escape special character X (i.e. {) </td> </tr> <tr> <td> Ctrl or Alt or Shift or Cmd or Meta or Option-X</td><td> <span class="key">Ctrl-C</span> </td><td> Describe a keystroke, rendering varies based on theme. </td> </tr> <tr> <td> -- (2 hyphens)</td><td> --</td><td> insert an en-dash </td> </tr> <tr> <td> --- (3 hyphens)</td><td> ---</td><td> insert an em-dash </td> </tr> <tr> <td> ---- (4+ hyphens) </td><td><hr class="line"/> </td><td> creates a horizontal rule </td> </tr> </table><p class="paragraph"/> <h3 class="heading-1">Macros<p class="paragraph"/></h3> FinScribe includes a number of macros, which are split into a set of core macros that are always available, as well as macros provided by various plugins, which may be enabled by a system administrator on a case-by-case basis.<p class="paragraph"/> Macros enable a page author to add extra functionality or include dynamic content on a page. Each macro has a name that's used to identify it and a given macro is specified in a page by surrounding its name by curly braces. For example:<p class="paragraph"/> <div class="code"><pre><pre> {mymacro} </pre></pre></div><p class="paragraph"/> <h3 class="heading-1.1">Containers<p class="paragraph"/></h3> Each macro may take one or more arguments that control the way the macro works, and may also take a piece of content to operate on, in which case we call that macro a "container". A macro that is a container consists of a matching pair of {macro} tags with the content in between.<p class="paragraph"/> For example:<p class="paragraph"/> <div class="code"><pre><pre> {my_container_macro}Some content{my_macro_container} </pre></pre></div><p class="paragraph"/> <h3 class="heading-1.1">Arguments </h3> A macro that takes arguments specifies its arguments by passing them after the macro name, separated from the macro name by a colon. Multiple arguments are separated from each other by a "pipe" symbol (|). Note that there should not be any spaces between any of the elements in a macro definition. For example:<p class="paragraph"/> <div class="code"><pre><pre> {macro:arg1=value1|arg2=value2|argN=valueN} </pre></pre></div><p class="paragraph"/> <h3 class="heading-1.1">Macros in HTML content<p class="paragraph"/></h3> Macros are also available in FinScribe pages that use HTML format, as well. Each macro is available in HTML format as a tag or container with the same name as the macro. Arguments are passed as attributes to the tag or container in the standard HTML fashion.<p class="paragraph"/> For example:<p class="paragraph"/> <div class="code"><pre><pre> <mymacro arg1=<i><font color=darkred>"value1"</font></i> arg2=<i><font color=darkred>"value2"</font></i> argN=<i><font color=darkred>"valueN"</font></i>> </pre></pre></div><p class="paragraph"/> or<p class="paragraph"/> <div class="code"><pre><pre> <my_macro_container>Some content</my_macro_container> </pre></pre></div><p class="paragraph"/> <h3 class="heading-1.1">Examples<p class="paragraph"/></h3> An example of a macro that doesn't take any arguments:<p class="paragraph"/> <div class="code"><pre><pre> {macro-list} </pre></pre></div><p class="paragraph"/> In HTML Mode:<p class="paragraph"/> <div class="code"><pre><pre> <macro-list> </pre></pre></div><p class="paragraph"/> An example of a macro that takes a few arguments:<p class="paragraph"/> <div class="code"><pre><pre> {weblog:path=some/path|max=25} </pre></pre></div><p class="paragraph"/> In HTML Mode:<p class="paragraph"/> <div class="code"><pre><pre> <weblog path=<i><font color=darkred>"some/path"</font></i> max=<i><font color=darkred>"25"</font></i>> </pre></pre></div><p class="paragraph"/> An example of a container macro that doesn't require arguments:<p class="paragraph"/> <div class="code"><pre><pre> {tip}Here's a helpful tip{tip} </pre></pre></div><p class="paragraph"/> In HTML mode:<p class="paragraph"/> <div class="code"><pre><pre> <tip>Here's a helpful tip</tip> </pre></pre></div><p class="paragraph"/> An example of a container macro that takes arguments:<p class="paragraph"/> <div class="code"><pre><pre> {api:lang=pike}sscanf{api} </pre></pre></div><p class="paragraph"/> In HTML Mode:<p class="paragraph"/> <div class="code"><pre><pre> <api lang=<i><font color=darkred>"pike"</font></i>>sscanf</api> </pre></pre></div><p class="paragraph"/> <h3 class="heading-1">Available Macros<p class="paragraph"/></h3> The following table lists all of the wiki macros bundled in these two categories and lists the plugin that provides each macro.<p class="paragraph"/> <table _parsed="1"> <tr> <th>Macro</th> <th>Plugin</th> <th>Container</th> <th>Description </th> </tr><tr> <td>table</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>link</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>hello</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>break</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>code</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>quote</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>boggle</td> <td>core</td> <td></td> <td> </td> </tr> <tr> <td>api</td> <td>core</td> <td></td> <td> </td> </tr> <tr> <td>macro-list</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>image</td> <td>core</td> <td></td> <td> </td> </tr> <tr> <td>weblog</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>object-index</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>attachment-index</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>category-index</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>category-output</td> <td>core</td> <td></td> <td> </td> </tr> <tr> <td>subpage-output</td> <td>core</td> <td></td> <td> </td> </tr> <tr> <td>deck</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>page</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>card</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>folder</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>warning</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>note</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>info</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>tip</td> <td>core</td> <td>Y</td> <td> </td> </tr> <tr> <td>include</td> <td>core</td> <td>N</td> <td> </td> </tr> <tr> <td>album</td> <td>album</td> <td></td> <td> </td> </tr> <tr> <td>category-cloud</td> <td>category_cloud</td> <td>N</td> <td> </td> </tr> <tr> <td>search-dialog</td> <td>fulltext</td> <td>N</td> <td> </td> </tr> <tr> <td>search-results</td> <td>fulltext</td> <td>N</td> <td> </td> </tr> <tr> <td>gravatar</td> <td>gravatar</td> <td>N</td> <td> </td> </tr> <tr> <td>recent-changes</td> <td>recent_changes</td> <td>N</td> <td> </td> </tr> <tr> <td>rss-reader</td> <td>rss_reader</td> <td>N</td> <td> </td> </tr> <tr> <td>rss-output</td> <td>rss_reader</td> <td>Y</td> <td></td> </tr> </table><p class="paragraph"/> <h3 class="heading-1.1">Link Macro<p class="paragraph"/></h3> {link:url|target|img=no}<p class="paragraph"/> where <i class="ital">target</i> is the (optional) text containing the link, <i class="ital">url</i> is the linked url and img is an optional argument that disables the "external link" icon that appears next to each link.Fins 0.9.7http://blogs.law.harvard.edu/tech/rss